home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr13 / hfnd10.zip / README.TXT < prev   
Text File  |  1995-03-17  |  13KB  |  350 lines
  1.  
  2.  
  3.                              HFIND Version 1.0
  4.  
  5.                           Highlighting text FINDer
  6.  
  7.  
  8.  
  9.         HFIND is Shareware (see below).  This means you must pay for
  10.         it if you continue to use it after a trial period.
  11.  
  12.  
  13.    Description:
  14.  
  15.         HFIND's function is straightforward:  find text in text files.
  16.         The reason you should choose HFIND over all those other text
  17.         finders is simple.  HFIND highlights the text you were looking
  18.         for when it displays the line in which the text was found.
  19.  
  20.         Especially if you use your PC's 50-line mode (included), it can
  21.         be hard to see what you were looking for in a crowded screen
  22.         full of search results.  HFIND highlights what it found in one
  23.         of several ways.  
  24.  
  25.         If you use ANSI.SYS (or equivalent, see next section), the
  26.         search target is indicated within its line by bright yellow
  27.         text.  If ANSI.SYS is not present, the target is indicated
  28.         by surrounding arrows.
  29.  
  30.  
  31.    Installation:
  32.  
  33.         Put HFIND.EXE (and L50.COM if you wish, see below) in a
  34.         directory in your path.  I keep a directory called UTIL on
  35.         C: for just such goodies as HFIND and L50.
  36.  
  37.  
  38.    Running the program:
  39.  
  40.         Now just type something like:
  41.  
  42.                 hfind the readme.txt
  43.  
  44.         HFIND will display all the lines in this file that contain
  45.         the text "the".  These may be contained within other words,
  46.         or alone, HFIND is not particular.  (It is, however, picky
  47.         about upper/lower case unless you tell it otherwise with the
  48.         -i switch (see below)).  If there is more than one occurrence
  49.         of the target in a line, only the first is highlighted.
  50.  
  51.  
  52.    Details (if you forget these, just type HFIND for a quick view):
  53.  
  54.      Command line:
  55.  
  56.         HFIND [switches] expression filespec
  57.  
  58.  
  59.      Switches (optional):
  60.         -c : print only filename and (C)ount of the matching lines
  61.                 in each file
  62.  
  63.         -l : print only the names of the files that contain matching
  64.                 (L)ines
  65.  
  66.         -n : print the line (N)umber of each matching line before it
  67.  
  68.         -i : (I)gnore target's case
  69.  
  70.         -h : print filename with each output line (no mnemonic)
  71.  
  72.         -q : (Q)uiet, no highlighting even if available
  73.  
  74.         -f <filename> : the regular expression(s) are taken from the
  75.                 (F)ile whose name follows (the space between -f and
  76.                 filename is needed).  For example, HFIND TARGETS.LST
  77.                 *.TXT will find any of the targets listed in
  78.                 TARGETS.LST in all files with the extension TXT.
  79.                 The target file may contain targets separated by
  80.                 "|" or on separate lines.  Don't use enclosing quotes
  81.                 within the target file.
  82.  
  83.         Switches may be combined for brevity. For example,
  84.  
  85.            HFIND -nif targ *.c
  86.  
  87.         will ignore case, print line numbers, and take targets from the
  88.         file "targ" when searching through all files *.c.
  89.  
  90.      Expression:
  91.         An expression is a series of characters which may be enclosed
  92.         in double-quotes.  For simple targets with no special characters,
  93.         the quotes are optional.
  94.  
  95.         In order to include spaces in the target on the command line,
  96.         you must enclose the entire expression in quotes (or use \s,
  97.         see below).  Otherwise, DOS will treat each part as a separate
  98.         command.
  99.  
  100.         The following characters have special meaning in an expression:
  101.  
  102.            .   - any character (wildcard)
  103.            "   - a pair of these encloses the target expression
  104.            \   - next character literal.  Used when looking for
  105.                    otherwise special characters, e.g. to find a
  106.                    period, enter "\.", to find a \, use "\\".
  107.            \s  - space
  108.            \t  - tab
  109.            \n  - new line
  110.            ^   - beginning of line
  111.            $   - end of line
  112.            *   - an expression followed by * matches 0 or more 
  113.                    of that expression, e.g.  "ho*" matches "h",
  114.                    "ho", "hoo", "hooo"...
  115.  
  116.            []  - surrounds a list of possible characters, case sensitive,
  117.                    quotes required.  E.g. "[aeiou]" (quotes required)
  118.                    finds any vowel
  119.            -   - makes a range of letters or numbers within []s
  120.                    E.g. "[a-f]" will find one of the first six letters
  121.            ^   - when first within [] means any character BUT those listed
  122.                    E.g. "a[^b]c" will not find 'abc', but will find
  123.                    'aac', 'acc', 'adc'...
  124.  
  125.            |   - used only as an OR between targets, e.g. "yes|no" looks
  126.                    for both "yes" and "no" and will print a line with each
  127.                    if found.  Requires the surrounding quotes when used on
  128.                    command line.
  129.  
  130.            any other character is taken literally.
  131.  
  132.         These can be combined willy-nilly to build the exact target you
  133.         need.  Here is an example:
  134.  
  135.            HFIND -n "^[a-z][a-z]*[\s\t]*.*([^;]*)[^;]*$" *.c
  136.  
  137.         will produce a list of functions in a C program (try it!).
  138.  
  139.  
  140.      Filespec:
  141.         A single specification of file(s) to search in, pathname and
  142.         wildcards are allowed, e.g. C:\TEXT\D*.T??.  Filenames are not
  143.         case sensitive.
  144.  
  145.  
  146. Special Requirements:
  147.  
  148.         In order to see the yellow highlighting (as opposed to the
  149.         target being surrounded by arrow characters) some form of
  150.         ANSI escape sequence processor must be installed.
  151.  
  152.         The traditional version, ANSI.SYS, is provided with DOS.  It
  153.         is found in the DOS subdirectory and must be installed by
  154.         CONFIG.SYS.  A line something like:
  155.  
  156.                 DEVICE=C:\DOS\ANSI.SYS
  157.  
  158.         must be included.  See your DOS documentation for details.
  159.  
  160.         In addition, there are several products available that are
  161.         faster/smaller/fuller/better than DOS's ANSI.SYS.  Some of
  162.         these are PC Magazine's ANSI.COM, FANSI-CONSOLE, NANSI,
  163.         NNANSI, VANSI, QUIKANSI...  These are available on bulletin
  164.         boards, the Internet, from friends and coworkers...
  165.  
  166.         I use ANSI.COM from PC Magazine.  I have found, though, that
  167.         my computers prefer that it not be loaded high.  (If you 
  168.         don't know what that means, you needn't worry).
  169.  
  170.  
  171. Suggestions:
  172.  
  173.         Since DOS has special meaning for the greater-than and less-
  174.         than characters <> and the pipe character |, you must use the
  175.         enclosing quotes if you are looking for them.
  176.  
  177.         If you wish to redirect HFIND's output to a file for further
  178.         processing (or HFINDing), it is best to use the -q option.
  179.         If you do not, the resulting file will contain the pointer
  180.         characters.  This may affect further processing.
  181.  
  182.         If your search results in more than a screenful of results,
  183.         you may wish to pipe the output through MORE.  This will
  184.         cause the printout to pause at each screenful, waiting for
  185.         you to press a key.  This is how this is done:
  186.  
  187.                 HFIND targetstuff files | more
  188.  
  189.         MORE is a DOS command which should be in your path.  MORE,
  190.         however, seems to defeat ANSI's processing (i.e. HFIND does
  191.         not detect its presence).  So HFIND's results are indicated
  192.         with the special characters instead of with the color yellow.
  193.  
  194.  
  195. Files:
  196.         HFIND.EXE   - the executable program
  197.         README.TXT  - this file with registration form
  198.         FILE_ID.DIZ - short description of the program
  199.         L50.COM     - utility to set screen to 50 lines (type MODE 80
  200.                              to return to 25 lines)
  201.  
  202.  
  203. Shareware:
  204.  
  205.         Shareware distribution gives users a chance to try software 
  206.         before buying it. If you try a Shareware program and continue 
  207.         using it, you are required to register it.
  208.  
  209.         Copyright laws apply to both Shareware and retail software, and 
  210.         the copyright holder retains all rights, with a few specific 
  211.         exceptions as stated below. Shareware authors are accomplished 
  212.         programmers, just like retail authors, and the programs are of 
  213.         comparable quality. (In both cases, there are good programs and 
  214.         bad ones!) The main difference is in the method of distribution. 
  215.         The author specifically grants the right to copy and distribute 
  216.         the software, either to all and sundry or to a specific group. 
  217.         For example, some authors require written permission before a 
  218.         commercial disk vendor may copy their Shareware. 
  219.  
  220.         Shareware is a distribution method, not a type of software. You 
  221.         should find software that suits your needs and pocketbook, 
  222.         whether it's retail or Shareware. The Shareware system makes 
  223.         fitting your needs easier, because you can try before you buy. 
  224.         And because the overhead is lower, prices are lower also. 
  225.         Shareware has the ultimate money-back guarantee -- if you don't 
  226.         use the product, you don't pay for it. 
  227.  
  228.  
  229. Distribution:
  230.  
  231.         You are free to distribute this package only if all of the above 
  232.         files are kept intact and are distributed together, and no fee, 
  233.         charge or other compensation is accepted or requested without the 
  234.         expressed written permission of Robert B. Peck. 
  235.  
  236.         Shareware disk vendors may NOT CHARGE a fee for HFIND. However 
  237.         you may include HFIND on a diskette/CD-ROM for which you charge a 
  238.         nominal distribution fee. The purchaser of said diskette must be 
  239.         informed in advance that the fee paid to acquire the diskette 
  240.         does NOT relieve said purchaser from paying the Registration Fee 
  241.         for HFIND if said purchaser uses HFIND.
  242.  
  243.         Operators of electronic bulletin board systems (Sysops) may post 
  244.         HFIND for downloading by their users without written permission. 
  245.         A fee may be charged for access to the BBS as long as no specific 
  246.         fee is charged for  downloading HFIND. 
  247.  
  248.  
  249. Warranty and Limitation of Liability:
  250.  
  251.         HFIND is supplied as it is without any warranty of any kind, 
  252.         either expressed or implied, including without limitation the 
  253.         warranties of merchantability and of fitness for any purpose. In 
  254.         no event shall Robert B. Peck be liable for any damages 
  255.         whatsoever, including direct, indirect, incidental, consequential, 
  256.         loss of business profits or special damages, from the use of 
  257.         HFIND.  In no case shall Robert B. Peck's liability exceed the 
  258.         license fees paid for the right to use the licensed software. 
  259.  
  260.  
  261. Evaluation and Registration:
  262.  
  263.         HFIND is not free software.  This license allows you to use
  264.         this software for evaluation purposes without charge for a
  265.         period of 30 days starting at your first use.  If you use
  266.         this software after the 30 day evaluation period, a
  267.         registration fee is required. 
  268.  
  269.         In return for your registration, you will receive a 3.5" disk
  270.         with the next version of HFIND on it (determined by need for
  271.         updates and success of the program).  You will also be
  272.         supporting the Shareware concept as well as contributing to
  273.         the author's wellfare.
  274.  
  275.         So, register and tell me what you want to see in the next version.
  276.  
  277.  
  278. Registering HFIND:
  279.  
  280.         Cost:
  281.           1 copy         $10
  282.           2-10 copies    $ 8
  283.          11-35 copies    $ 7
  284.          more than 50    negotiable
  285.  
  286.         Payment may be made in cash, money order or check, in US funds,
  287.         payable and sent to:
  288.  
  289.           Robert B. Peck
  290.           1005 Hollycrest Dr.
  291.           Champaign, IL   61821-4205
  292.  
  293.           (email bpeck@prairienet.org)
  294.  
  295.         Use the following order form.  Please print clearly.
  296.  
  297. HFIND HFIND HFIND HFIND HFIND HFIND HFIND HFIND HFIND HFIND HFIND 
  298.  
  299.  
  300.         Number of copies at $10 ea. _____
  301.           OR
  302.         Number of copies at $ 8 ea. _____
  303.           OR
  304.         Number of copies at $ 7 ea. _____
  305.  
  306.         Total cost: _________________________
  307.  
  308.         Name: _____________________________________________________
  309.  
  310.         Company: __________________________________________________
  311.  
  312.         Address: __________________________________________________
  313.  
  314.         City / State / Zip: _______________________________________
  315.  
  316.         Country: __________________________________________________
  317.  
  318.         Daytime Phone: ____________________________________________
  319.  
  320.         E-Mail address: ___________________________________________
  321.  
  322.         Which version of HFIND do you have ________________________
  323.  
  324.         How did you find HFIND ____________________________________
  325.  
  326.         How can future versions of HFIND help you better?
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.         Comments, good or bad:
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348. HFIND HFIND HFIND HFIND HFIND HFIND HFIND HFIND HFIND HFIND HFIND
  349.  
  350.